-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Switch to Furo docs theme #10498
Closed
Closed
Switch to Furo docs theme #10498
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 5669101634
💛 - Coveralls |
Eric-Arellano
changed the title
[experiment] Switch to Furo docs theme
Switch to Furo docs theme
Jul 26, 2023
mtreinish
pushed a commit
to Qiskit/qiskit-metapackage
that referenced
this pull request
Jul 28, 2023
See Qiskit/qiskit#10498 for the motivation. Note that in Terra, we distinguish between dev/CI builds vs. prod builds. We don't make that distinguishment here because we don't get much dev activity in this repo.
jakelishman
pushed a commit
to jakelishman/qiskit-terra
that referenced
this pull request
Aug 11, 2023
See Qiskit#10498 for the motivation. Note that in Terra, we distinguish between dev/CI builds vs. prod builds. We don't make that distinguishment here because we don't get much dev activity in this repo.
I believe that #10611 obsoleted this, but it's worth checking. |
Not quite. This PR distinguished between dev/CI vs prod builds and had some optimizations to speed up dev builds. I will open a dedicated PR for that. |
SamD-1998
pushed a commit
to SamD-1998/qiskit-terra
that referenced
this pull request
Sep 7, 2023
See Qiskit#10498 for the motivation. Note that in Terra, we distinguish between dev/CI builds vs. prod builds. We don't make that distinguishment here because we don't get much dev activity in this repo.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This switches to qiskit-sphinx-theme's Furo-based theme, which is based on pip docs. It makes our docs Carbon compliant and much more useful, including the left sidebar now including the whole page ToC for more functional navigation.
Furo is naively slower (Qiskit/qiskit_sphinx_theme#328): the docs build wall-time goes from 13.75 minutes to 40 minutes. So, we distinguish between prod builds (which will be added in Qiskit/qiskit-metapackage#1779) vs. dev/CI builds. CI builds only take 15 minutes, a 1.25 minute slowdown. The slowdown comes from
viewcode
(14 minutes) and including the API docs in the left sidebar (11 minutes).